pp108 : Case Management SOAP APIs

Case Management SOAP APIs

This topic lists the SOAP APIs used in Case management.

Category

Web Service Interface

Web Service Operation

Detail

Case Model Administration

Method Set Case Model Administration 4.2

   
   

ActivateCaseModel (deprecated)

Activates the deactivated Case model

   

DeactivateCaseModel (deprecated)

Deactivates the Case model

   

DeleteCaseModel (deprecated)

Deletes the deployed Case model from the runtime

   

GetCaseActivity

Retrieves the details of the activity associated with the Case model

   

GetCaseActivities

Retrieves the details of all the activities associated with the Case model

   

GetCaseIdentifiers

Retrieves the details of the Case identifiers associated with the Case model

   

GetCaseModel

Retrieves the details of a deployed Case model

   

GetCaseModels

Provides a list of deployed Case models based on the criteria specified in the query

   

PublishCaseModel (deprecated)

Deploys a new Case model or modifies an existing Case model in the run time environment

Case Instance Administration

Method Set Case Instance Administration 4.2

   
   

CloseCaseInstance

Completes the Case instance

   

DeleteCaseInstance

Deletes the Case instance

   

RestartCaseInstance

Restarts the Case instance

   

ResumeCaseIntance

Resumes the Case instance

   

SuspendCaseInstance

Suspends the Case instance

   

TerminateCaseInstance

Terminates the Case instance

Case Instance Execution

Method Set Case Instance Execution 4.2

   
   

CreateCase

Executes the Case model

   

CompleteActivity

Completes the Case activity in the release state

   

CompleteActivityWithFollowup

Completes the Case activity and plans for the follow-up activities

   

GetActivityInstance

Provides the details of a activity instance

   

GetActivityInstances

Provides the details of the activity instances which are triggered by the Case instance

   

GetBusinessEvents

Provides all the business events which are allowed to be raised from a Case activity

   

GetCaseData

Fetches the data associated with the specified Case instance

   

GetCaseInstance

Fetches the details of a Case instance

   

GetCaseInstances

Fetches the details of the Case instance(s) details based on the specified criteria such as status, target, and so on.

   

GetCaseVariables

Retrieves the details of the Case variable associated with the Case model

   

GetFollowupActivities

Returns all the follow-up activities for an activity instance

   

PlanActivities

Allows planning of activities

   

PlanIntermediateActivities

Allows planning of Intermediate follow-up type activities

   

SendEvent

Used to send a business event to a Case instance

   

ConsumeEvent

This API is deprecated. Use SendEvent instead

   

UpdateCaseData

Updates the data of a Case instance

   

UpdateCaseVariables

Updates the Case variables associated to a Case instance

    GetCaseInstanceDetails Fetches the details of the Case instance details based on the specified criteria such as status, target, activity instances, state instances and so on.
 

Method Set Attachments 4.2

   
   

GetAttachments

Fetches the attachments associated with a particular Case instance

   

GetAttachments associated with Activity

Fetches the attachments associated with an activity of the Case instance

   

DeleteAttachment

Deletes the attachment associated with the Case instance